/* Copyright (c) 2010 OFXKit
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#import <Foundation/Foundation.h>

#import "OFXLoanAccount.h"
#import "OFXLoanTransaction.h"

@interface OFXAmortizationTransaction : OFXLoanTransaction {
  NSNumber* balanceAmount;
  NSNumber* currentLoanInterestRate;
  NSNumber* initialLoanBalance;
  NSString* interestRateType;
  NSDate*   interestRateValidAsOf;
  NSNumber* paymentNumber;
  NSDate*   principalBalanceValidAsOf;
  NSNumber* principalLTD;
  NSNumber* principalYTD;
}

/**
 * @property balanceAmount
 * @brief Balance of loan
 */
@property(retain) NSNumber* balanceAmount;

/**
 * @property currentLoanInterestRate
 * @brief Current loan interest rate
 */
@property(retain) NSNumber* currentLoanInterestRate;

/**
 * @property initialLoanBalance
 * @brief Initial balance of loan
 */
@property(retain) NSNumber* initialLoanBalance;

/**
 * @property interestRateType
 * @brief Type of interest rate
 *
 * One of the following: 
 * - FIXED = Fixed rate for the life of the loan 
 * - FLOATING = Floating interest rate 
 * - ARM = Adjustable rate mortgage
 */
@property(retain) NSString* interestRateType;

/**
 * @property interestRateValidAsOf
 * @brief Date interest rate is valid as of.
 */
@property(retain) NSDate*   interestRateValidAsOf;

/**
 * @property paymentNumber
 * @brief Payment number
 */
@property(retain) NSNumber* paymentNumber;

/**
 * @property principalBalanceValidAsOf
 * @brief Principal balance valid as of date
 */
@property(retain) NSDate*   principalBalanceValidAsOf;

/**
 * @property principalLTD
 * @brief Total principal paid loan to date
 */
@property(retain) NSNumber* principalLTD;

/**
 * @property principalYTD
 * @brief Total principal paid year to date
 */
@property(retain) NSNumber* principalYTD;

@end
